Skip to content

Conversation

@adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Jun 4, 2024

Question Answer
JIRA Ticket
Versions
Edition

Each month, along side the "New in documentation" page, pages with changes can be highlighted in the table of content / navigation.

"new" doesn't necessarily mean that the page is new but that something is new in it. "Update" is too long for the little place there is in the ToC. To distinguish "new" and "updated" isn't relevant enough. Let's have only "new".

By having month_change: true in the page metadata (at the top of its .md file), a "New" pill is displayed at the right side of its ToC entry.

Because of this mechanism, it can't be added to the PHP API Reference which is directly in HTML and can't be converted to a Markdown trick.

Previews:

Look in ToC for May changes:

It works when the item is the current page, and when it isn't.

"new" on current
"new" elsewhere

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Code samples are working
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

@adriendupuis adriendupuis marked this pull request as ready for review June 4, 2024 12:44
@adriendupuis adriendupuis requested a review from IdaDra June 4, 2024 12:47
@adriendupuis
Copy link
Contributor Author

Thank you @juskora for this idea spotted in CKEditor Doc

@adriendupuis adriendupuis changed the title "New" pill in the ToC "new" pill in the ToC Jun 6, 2024
@adriendupuis
Copy link
Contributor Author

Thank you @IdaDra for tuning the design.

@adriendupuis adriendupuis merged commit 04376a1 into master Jun 6, 2024
@adriendupuis adriendupuis deleted the new-pill branch June 6, 2024 11:48
adriendupuis added a commit that referenced this pull request Jun 6, 2024
(cherry picked from commit 04376a1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant